home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / EDITORS / WEBKIT3 / WebGuide < prev   
Text File  |  1996-08-29  |  13KB  |  303 lines
  1. User web site document
  2. ~~~~~~~~~~~~~~~~~~~~~~
  3. 29 Aug 1996
  4.  
  5. For each of our users, we are allocating a 2MByte web space. This is 2M of
  6. whatever you want - text, images or sounds, for business or private use.
  7.  
  8. If you want any more, then the prices are as follows :
  9.  
  10. 0-2MBytes       FREE
  11. 2M-5M           £10 per month
  12. Above 5M, contact us for more details. Prices are ex-VAT.
  13.  
  14. This document shows how a web page is to be created on our web site. Please
  15. note that we are unable to offer support on HTML design, but we will support
  16. the WebPack software, and answer any questions on the web server system.
  17.  
  18. Your home directory
  19. ~~~~~~~~~~~~~~~~~~~
  20. If, for example, your email address is "zenith@argonet.co.uk", then your web
  21. page will be "http://www.argonet.co.uk/users/zenith". You are allocated
  22. 2MBytes of data, which is stored in ONE directory.
  23.  
  24. How to create web pages
  25. ~~~~~~~~~~~~~~~~~~~~~~~
  26. You will need to create HTML pages - You can do this using !Edit (or your
  27. favourite text editor), but you will need to understand HTML. HTML is a
  28. fairly simple affair, but it can get quite complex. This document will not
  29. tell you how to create a really good web page; it will only tell you the
  30. basics. If you want more information about HTML, then it's best to read a
  31. book.
  32.  
  33. The first thing you need to learn about is tags. HTML uses tags to denote
  34. certain aspects of a piece of text. These tags are text strings, enclosed
  35. within "<" and ">". For example, "<HEAD>" would mean the header of an HTML
  36. document. These tags can be in be in capitals or in lower case. In this
  37. brief guide, they are shown as capitals, but you must keep the case the
  38. same, so if you start off with lower case, you must use lower case for all
  39. the other tags.
  40.  
  41. Since these tags are applied to blocks of text, you also need to turn off
  42. tags, such as bold. This is done in the same way, except the tag is
  43. preceeded by "/".
  44.  
  45. For example, "<B>This is some bold text</B> and this isn't" would
  46. produce just that. The tag "B" indicates that the text following it will be
  47. displayed in bold. Similarly, "I" is used for italic.
  48.  
  49. An HTML document is split into two sections - the Header and the Body. The
  50. header contains information such as the title of the page, while the body
  51. has the main text.
  52.  
  53. An example HTML page is :
  54.  
  55. <HTML>
  56. <HEAD><TITLE>My home page (mk 1)</TITLE>
  57. </HEAD>
  58. <BODY BGCOLOR="#ffffff">
  59. I am <I>very</I> clever, but
  60. don't
  61. rush me!
  62. </BODY>
  63. </HTML>
  64.  
  65. The first line tells the web browser that this is an HTML document. If you
  66. copy these lines to another file, and make sure it's file type is "HTML",
  67. then you can use Voyager's web program to view it. If you look closely, you
  68. will find that the carriage returns at the end of "but", "don't" and "me!"
  69. aren't actually displayed. HTML is known as a free-format system, where
  70. carriage returns, multiple spaces and tabs aren't used at all.
  71.  
  72. So, how do you get a carriage return? Simple. The token "BR" indicates a
  73. break in the line. It is one of the tags that doesn't have an end, so you
  74. only need to put it in where you want the web browser to split the line.
  75.  
  76. You can also do paragraph breaks with a <P> tag. Two or more <BR>s will be
  77. treated like multiple spaces - only the first will be used.
  78.  
  79. <P>A paragraph of text.
  80. <P>Another paragraph.
  81.  
  82. In this example, the <P> tag tells the browser a new paragraph has started.
  83. There are occasions when you will come across a </P> tag. You can ignore it
  84. for now.
  85.  
  86. Links (pointing to other web pages)
  87. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  88. The next thing to look at is links. Links allow you to jump from one page to
  89. another, not necessarily in the same user directory, or even site!
  90.  
  91. A link (or anchor) is denoted by the token "A". This token is more complex
  92. than the previous one, as it has some extra parameters inside the "<>"s.
  93.  
  94. An example link is :
  95.  
  96. To find some information, click <A HREF="http://www.argonet.co.uk">here</A>
  97.  
  98. The HREF indicates where the link is going to go. If you were to insert this
  99. into the HTML file, the "here" text would be coloured blue, and underlined.
  100.  
  101. You can have links to other pages inside your directory very easily. For
  102. example, the lines :
  103.  
  104. <A HREF="http://www.argonet.co.uk/users/zenith/aboutme.html">
  105.  
  106. and
  107.  
  108. <A HREF="aboutme.html">
  109.  
  110. would be the same, and would also have the advantage that you can test out
  111. your web pages before putting them on our web site, using Voyager's web
  112. browser.
  113.  
  114. These references could also be to email addresses, for example, you could
  115. use :
  116.  
  117. <A HREF="mailto:support@argonet.co.uk">ArgoNet Technical Support</A>
  118.  
  119. which would create a link on the text ArgoNet Technical Support, so that when
  120. you click on it, an e-mail window will appear.
  121.  
  122. Images
  123. ~~~~~~
  124. Images form a major factor of web pages. You can place images onto your web
  125. pages, using the token "Img". This token is used in a similar fashion to
  126. the link token, in that it takes other parameters.
  127.  
  128. An example link would be :
  129.  
  130. <IMG SRC="mypiccy.gif" ALT="A picture of me">
  131.  
  132. The SRC extra parameter is where the image is stored. The ALT parameter is
  133. some textual element which is displayed if the web browser has images turned
  134. off, or it is a text-only browser.
  135.  
  136. Note that images should be GIF format files, and CANNOT be Acorn sprites. If
  137. you have a sprite you wish to convert to GIF, use !WebGIF, !Creator,
  138. SprToGIF, all of which can be downloaded from our FTP site, inside the PD
  139. directory.
  140.  
  141. At a pinch, you could use JPEGs, but some (early) browsers do not accept
  142. JPEGs as a file format.
  143.  
  144. File names
  145. ~~~~~~~~~~
  146. For HTML documents, you will have to adhere to some naming standards:
  147.  
  148. Under Unix, filenames are case sensitive, so "Acorn", "acorn", "ACORN" and
  149. "AcOrN" are different files. However, there is an informal convention of
  150. sticking to lower case filenames for HTML documents.
  151.  
  152. Like PCs, filenames can have full-stops (".") in them.
  153.  
  154. GIF files MUST end in ".gif", JPEGs in ".jpeg", and HTML files in ".html".
  155. When referring to them inside HTML documents, use the full-stop, but as
  156. Acorn's can't use full-stops in filenames, you will have to replace the "."
  157. in the filename with a "/". To demonstrate this, an image would be
  158. referenced in an HTML document as "piccy.gif". On the Acorn machine, this is
  159. stored on your hard disc as "piccy/gif".
  160.  
  161. The first page of your home page is called "index.html" (which would be
  162. stored on your hard disc as "index/html").
  163.  
  164. All your files for your web page will have to reside in one directory. Please
  165. note that on a FileCore system, such as ADFS or RAMFS, you are limited to 77
  166. files in a directory. If you want more, you could store the files to a PC
  167. floppy disc (or a PC partition on your hard disc). However, you'll be
  168. limited to the DOS 8+3 filename. Make sure the files have the right type,
  169. otherwise !WebPack won't be able to rename them.
  170.  
  171. Filenames can be very long. If you want to simulate this, use !LongFiles,
  172. also available from our FTP PD site.
  173.  
  174. If you want to find some links, or some resources for your web site, then
  175. you could try some search engines, such as Yahoo, or Excite, and look up
  176. graphics, or something like it. Their addresses are :
  177.  
  178. http://www.yahoo.com/
  179. http://www.excite.com/
  180.  
  181. Testing the web pages
  182. ~~~~~~~~~~~~~~~~~~~~~
  183. Create a directory which you will put your web pages in. You will need an
  184. HTML file called "index/html", otherwise your page won't work. All you need
  185. to do is double-click on the HTML file. This "index.html" page is referred
  186. to as your 'home page', because it is the first page someone looking at
  187. your site will see.
  188.  
  189. All references within your directory shouldn't have any form of pathname at
  190. the beginning of the reference, as shown above. These references should be
  191. in Unix format, so that on your hard disc, a GIF file would be represented
  192. "ADFS::HardDisc4.$.WebPages.mypiccy/gif", whereas the reference stored in
  193. the HTML document will be "mypiccy.gif".
  194.  
  195. Note that all files are case sensitive, so you can't put it as "MyPiccy.GIF"
  196. which would work when testing using RISC OS.
  197.  
  198. Also, if the file would be longer than 10 characters, you can truncate it to
  199. 10 characters, so the file "voyager.gif" would be stored in your directory
  200. as "voyager/gi". For an example of this, look at the HTML page inside
  201. Voyager's web browser. You will also find other interesting bits and pieces
  202. as well!
  203.  
  204. Adding binaries (archives) and text files
  205. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  206. You can include binaries which can be FTP downloaded, for example, to
  207. contain some software you've written you wish to release. To create the
  208. link, use the same method for referring to other pages, ie :
  209.  
  210. To download my software, click <A HREF="my_arc.arc">here</A>.
  211.  
  212. You will need to be careful with the filenames - an ArcFS archive would
  213. have a ".arc" extension; a SparkFS archive ".zip" and a PackDir file as
  214. ".pak". If you want to put other types of files, archive them using one of
  215. these archivers instead. It'll also make your site smaller as well.
  216.  
  217. If you want to have any text files, they MUST have the extension "/txt",
  218. otherwise, they end up with the extension "/map" for image maps. Because of
  219. the 10 character limit, WebPack will use just "/t" to see if you want it as a
  220. text file, so "image/txt" and "imagine/tx" would end up as text files
  221. (assuming they were file-typed as text files), but "imaginate/" would be an
  222. image map file.
  223.  
  224. WebPack will expand known extensions to the following :
  225.  
  226. File type &695 (GIF) - /gif
  227. File type &faf (HTML) - /html
  228. File type &c85 (JPEG) - /jpeg
  229. File type &fff (Text) - /map (unless it has /txt after the name)
  230.  
  231. TIMM will convert the further types :
  232.  
  233. File type &3fb (Archive) - /arc (ArcFS)
  234. File type &ddc (Archive) - /zip (SparkFS)
  235. File type &c46 (Tar) - /tar
  236. File type &68e (PackDir) - /pak
  237. File type &fb1 (PC .WAV) - /wav
  238.  
  239. The example web pages
  240. ~~~~~~~~~~~~~~~~~~~~~
  241. If you find that this sounds really daunting, then you can look at the
  242. example web page included. This has all the elements you need for a typical
  243. home page. You are free to edit it, and to view it, simply double-click on
  244. the index/html file. If it's been stored in the cache, click on Reload.
  245.  
  246. Sending us the web pages
  247. ~~~~~~~~~~~~~~~~~~~~~~~~
  248. With this document, there is an application - !WebPack. This will package
  249. up your directory containing your web pages and images. Simply drop the
  250. directory onto the !WebPack icon on the icon bar, and it produces a window.
  251. This window has several options on it, which will allow you to add your
  252. site to the ArgoNet list of users. If you wish to remove your name from
  253. this list (or you don't want to list it), then you can do so. The comments
  254. field is some comments you wish to use for your site.
  255.  
  256. This list is accessible from "http://www.argonet.co.uk/users/". It will
  257. automatically add the date and time it was modified.
  258.  
  259. When you click on "Create", a save box will be displayed. Save the file (not
  260. inside your web site directory) out, and FTP upload it to our FTP site, in
  261. the directory "incoming". The site will be transferred to the web shortly
  262. afterwards.
  263.  
  264. Please note that the files MUST be the correct file type - GIFs are filetype
  265. 695, JPEGs are C85, and HTML pages are FAF. !WebPack will use this to
  266. determine what extension to add, if the correct one has been truncated.
  267.  
  268. Also, the first version of !WebPack does not handle sounds - there are
  269. several formats available, but WAV is probably the most common.
  270.  
  271. Note that your old web site will be deleted, and replaced with what you send
  272. us.
  273.  
  274. You will be emailed when your site has been uploaded.
  275.  
  276. Validating the web pages
  277. ~~~~~~~~~~~~~~~~~~~~~~~~
  278. There are a number of servers available which will take your uploaded web
  279. pages, and validate them. These are generally very fussy, and will give
  280. errors for the slightest of problems.
  281.  
  282. One of these can be found at :
  283.  
  284. http://ugweb.cs.ualberta.ca/~gerald/validate/
  285.  
  286. There's an FAQ also accessible from this site regarding the vaildator.
  287.  
  288. Known problems
  289. ~~~~~~~~~~~~~~
  290. There may be a problem with ArcFS archives, if you have ArcFS running. If
  291. you do experience such problems, then quit ArcFS and try again.
  292.  
  293. Finally
  294. ~~~~~~~
  295. The world wide web is a large beast, and there is a huge wealth of
  296. information available on it. If you want people to look at your page, then
  297. try to make it look pretty, or unusual. If it looks bad, conversely, you
  298. may even end up on someones "worst sites to visit" list!
  299.  
  300. If you want, you can register your page with a search engine, so that other
  301. people can access it, and you could add it to the bottom of your signature,
  302. so when you post on newsgroups, or e-mail people, others can visit it.
  303.